config.cgi

Last update: April 2015

config.cgi is used to change FlashAir configurations. To change the config parameters, the MASTERCODE is required. You can change multiple parameters at the same time.

Parameter Description Parameter Example Firmware Version
APPAUTOTIME Set Connection Timeout APPAUTOTIME=3000000 2.00.00+
APPINFO Set Application's Unique Information APPINFO=0123ABCD4567EFGH 1.00.00+
APPMODE Set Wireless LAN Mode APPMODE=4 1.00.00+
APPNETWORKKEY Set Network Security Key APPNETWORKKEY=12345678 1.00.00+
APPSSID Set SSID APPSSID=flashair 1.00.00+
BRGNETWORKKEY Set Network Security Key for Internet Pass-Thru Mode BRGNETWORKKEY=12345678 2.00.02+
BRGSSID Set SSID for Internet Pass-Thru Mode BRGSSID=myhomelan 2.00.02+
CIPATH Set Wireless LAN Boot Screen Path CIPATH=/DCIM/100__TSB/FA000001.jpg 1.00.00+
CLEARCODE Clear Mastercode CLEARCODE=1 3.00.00+
MASTERCODE Set Mastercode MASTERCODE=0123456789AB 1.00.00+
TIMEZONE Set Timezone TIMEZONE=36 3.00.00+
WEBDAV Set FlashAir Drive(WebDAV) WEBDAV=1 3.00.00+

Set Connection Timeout

APPAUTOTIME

Set the automatic time-out period for Wireless LAN functionality. Time is measured in milliseconds. The available values are from 60000 to 4294967294, with a default value of 300000.
Specify 0 to disable the automatic time-out.
Note: The card would stop ex. if the power supply to the card stops.

The newly set value will be stored in the APPAUTOTIME parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&APPAUTOTIME=3000000&APPMODE=4

Set Application's Unique Information

APPINFO

Save information uniquely used by the application using 1 - 16 characters

The newly set value will be stored in the APPINFO parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&APPINFO=0123ABCD4567EFGH

Set Wireless LAN Mode

APPMODE

Set the Wireless LAN mode. The following modes are available:

0 Removes the write protection from the "Wireless LAN Boot Screen" image.
Sets the Wireless LAN to AP mode.
2 Removes the write protection from the "Wireless LAN Boot Screen" image.
Sets the Wireless LAN to STA mode.
3 Removes the write protection from the "Wireless LAN Boot Screen" image.
Sets the Wireless LAN to "Internet pass-thru" mode.
(FW 2.00.02+)
4 Wireless LAN functionality will be set when the card is turned on.
Sets the Wireless LAN to AP mode.
5 Wireless LAN functionality will be set when the card is turned on.
Sets the Wireless LAN to STA mode.
6 Wireless LAN functionality will be set when the card is turned on.
Sets the Wireless LAN to "Internet pass-thru" mode.
(FW 2.00.02+)
Other Undefined behaviour.

To learn more about AP mode, STA mode and Internet pass-thru mode, please read the CONFIG file page.

The newly set value will be stored in the APPMODE parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&APPMODE=4

Set Network Security Key

APPNETWORKKEY

Set the network security key using 0 - 63 characters. (To enable the security option, at least 8 characters are required.)

The newly set value will be stored in the APPNETWORKKEY parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&APPNETWORKKEY=12345678

Set SSID

APPSSID

Set the Service Set Identifier (SSID) using 1 - 32 characters.

The newly set value will be stored in the APPSSID parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&APPSSID=flashair

Set the Network Security Key for Internet pass-thru Mode

BRGNETWORKKEY

Set the network security key for Internet pass-thru mode.
The Network Security Key must be between 0 and 63 characters.

The newly set value will be stored in the BRGNETWORKKEY parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&BRGNETWORKKEY=12345678

Set SSID for Internet pass-thru Mode

BRGSSID

Set the SSID (Service Set Identifier, or name) of the network to use for Internet pass-thru mode.
The SSID must be between 1 and 32 characters.

The newly set value will be stored in the BRGSSID parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&BRGSSID=myhomelan

Set Wireless LAN Boot Screen

CIPATH

Set the full-path of the image to use as the wireless boot screen. The wireless boot screen is an image file that controls whether the Wireless LAN is ON or OFF when the Wireless LAN mode (APPMODE) is 0, 2, or 3.

The newly set value will be stored in the CIPATH parameter in the CONFIG file

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&CIPATH=/DCIM/100__TSB/FA000001.jpg

Clear Mastercode

CLEARCODE

Resets MASTERCODE. Removes MASTERCODE from the CONFIG file. LOCK=1 will be removed as well.

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&CLEARCODE=1

Set Mastercode

MASTERCODE

The MASTERCODE is a 12-digit hexadecimal number which is used as a password to set the SSID (APPSSID) and network security key (APPNETWORKKEY). The MASTERCODE parameter must match the current MASTERCODE (set in advance), otherwise any changes will not be saved in the CONFIG file.

The newly set value will be stored in the MASTERCODE parameter in the CONFIG file. LOCK=1 will be set at the same time.

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB

Set Timezone

TIMEZONE

Set the timezone that will be used to convert from FAT file time to UTC time when FlashAir Drive is run. The timezone is stored in 15 minute increments, ranging from -48 to 54. For example UTC standard time is 0, and Japan time (which is 9 hours ahead), is 36 (9(h)×4(15m)=36).

The newly set value will be stored in the TIMEZONE parameter in the CONFIG file.

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&TIMEZONE=36

Set FlashAir Drive(WebDAV)

WEBDAV

Set whether to enable or disable FlashAir Drive. The following modes are available:

0 Disable FlashAir Drive
1 Enable FlashAir Drive(read only)
2 Enable FlashAir Drive. Needs also UPLOAD=1 to write files.

The newly set value will be stored in the WEBDAV parameter in the CONFIG file.

Returns SUCCESS if successful, ERROR on failure.

Request Example:

http://flashair/config.cgi?MASTERCODE=0123456789AB&WEBDAV=1